---
title: Friendlier Words
description: A JavaScript package that creates friendly words to use in your app, handy for generating project names.
---

### Installation

To install `friendlier-words`, simply run the following command:

```sh title="Terminal"
pnpm add friendlier-words
```

### Usage

Here is an example of how to use `friendlier-words` for generating friendly words:

```tsx title="get-project-name.ts"
import { friendlyWords } from 'friendlier-words';

// Default (2 segments, '-')
// e.g. robust-chicken, happy-cat, modest-pear
const words = friendlyWords();

// Custom (3 segments, '_')
// e.g. keen_explorer_oak, comforting_cactus_constructor, playful_tiger_breeze
const words = friendlyWords(3, '_');
```

### Benefits

- **Easy to Use**: `friendlier-words` is easy to use and generates friendly words with a simple API.
- **Customizable**: You can customize the number of segments and the separator.

For more information and detailed documentation, visit the [`friendlier-words` GitHub repo](https://github.com/haydenbleasel/friendlier-words).
